Skip to content

Add Docusaurus documentation#85

Open
Dominik1999 wants to merge 1 commit into
mainfrom
dominik1999-claude/docs
Open

Add Docusaurus documentation#85
Dominik1999 wants to merge 1 commit into
mainfrom
dominik1999-claude/docs

Conversation

@Dominik1999
Copy link
Copy Markdown
Contributor

Summary

  • Set up Docusaurus matching the miden-base documentation pattern
  • Four documentation pages:
    • Overview: what the NTL is, why it exists, key properties
    • Design: note flow, tag routing, cursor pagination, streaming, block context, storage
    • For operators: installation, CLI flags, env vars, Docker Compose telemetry stack, monitoring, logging
    • For users: gRPC API reference, client integration pattern, cursor management, troubleshooting
  • Updated Makefile book target from mdbook to Docusaurus
  • Added .node-version (22) for compatibility

Test plan

  • cd docs && npm install && npm run start:dev serves locally (requires Node 22)
  • All 4 pages render correctly with sidebar navigation
  • make lint passes (no Rust changes)

🤖 Generated with Claude Code

Closes #76

Set up Docusaurus matching miden-base pattern with four pages:
- Overview: what the NTL is and why it exists
- Design: note flow, tag routing, cursor pagination, streaming, storage
- For operators: installation, CLI flags, env vars, Docker, monitoring
- For users: gRPC API reference, client integration, troubleshooting

Update Makefile book target to use Docusaurus instead of mdbook.

Closes #76

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Dominik1999 Dominik1999 added this to the Release v0.4.0 milestone Apr 24, 2026
@Dominik1999 Dominik1999 marked this pull request as ready for review April 24, 2026 09:45
@BrianSeong99
Copy link
Copy Markdown

hey dominik, went through this. content structure is solid - overview/design/operators/users is the right split. but the proto snippets in users.md don't match the actual proto. commitment_block_num, note_metadata, and FetchNotesRequest.limit don't exist in miden_note_transport.proto - only header and details. the block-context sections in design.md and users.md describe behavior the server doesn't have yet. these need to be regenerated from the real proto before merge.

@BrianSeong99
Copy link
Copy Markdown

not 100% sure on all of these yet but from a brief pass cross-referencing the source, seems like:

  • --enable-otel and --otel-endpoint aren't actual CLI flags - telemetry looks like it's controlled by OTEL_ENABLED / OTEL_TRACES_ENDPOINT env vars instead
  • make docker-build-node and make docker-run-node don't exist in the Makefile, only docker-node-up/down/restart
  • Docker persistence might be broken - Compose sets DATABASE_URL but the binary doesn't read it, so it could be defaulting to :memory:

@BrianSeong99
Copy link
Copy Markdown

also not 100% confirmed but from what i can tell:

  • "NTL does not deduplicate notes" looks wrong - there's a UNIQUE constraint on note id in the DB schema, so dupes would fail
  • streaming cursor behavior seems different from what's documented here - server might be ignoring the client-provided cursor

@BrianSeong99
Copy link
Copy Markdown

i'll review the issues i raised above more deeply and fix them. will also update this PR to follow the ingestion path instead of a standalone docusaurus site - same pattern as miden-client and node. i'll restructure the content under docs/external/src/ and create a separate PR in the docs repo to wire up the ingestion. will push updates to this branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation

3 participants